<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Whm_Functions_Dns</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Whm_Functions_Dns</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">WHM DNS Functions</p>
<p class="description"><p>Calls to DNS functions of the WHM XML and JSON APIs</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Peter Kumaschow</li>
				<li><span class="field">copyright:</span> Peter Kumaschow 2011</li>
				<li><span class="field">link:</span> <a href="http://docs.cpanel.net/twiki/bin/view/SoftwareDevelopmentKit/XmlApi">http://docs.cpanel.net/twiki/bin/view/SoftwareDevelopmentKit/XmlApi</a></li>
				<li><span class="field">license:</span> GNU</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Functions---Dns.php.html">/Functions/Dns.php</a> (line <span class="field">38</span>)
		</p>
		
				
		<pre><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html">Whm_Functions_Abstract</a>
   |
   --Whm_Functions_Dns</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																				
												<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#addzonerecord" title="details" class="method-name">addzonerecord</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$zone</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$requiredParams</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$optionalParams</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#dumpzone" title="details" class="method-name">dumpzone</a>
											(<span class="var-type">$domain</span>&nbsp;<span class="var-name">$domain</span>, <span class="var-type">$line</span>&nbsp;<span class="var-name">1</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#editzonerecord" title="details" class="method-name">editzonerecord</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#getzonerecord" title="details" class="method-name">getzonerecord</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$line</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#killdns" title="details" class="method-name">killdns</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#listmxs" title="details" class="method-name">listmxs</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#listzones" title="details" class="method-name">listzones</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#lookupnsip" title="details" class="method-name">lookupnsip</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$nameserver</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removezonerecord" title="details" class="method-name">removezonerecord</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#resetzone" title="details" class="method-name">resetzone</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#resolvedomainname" title="details" class="method-name">resolvedomainname</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#savemxs" title="details" class="method-name">savemxs</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html">Whm_Functions_Abstract</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_apiresponse">Whm_Functions_Abstract::$_apiresponse</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_method">Whm_Functions_Abstract::$_method</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_params">Whm_Functions_Abstract::$_params</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_querystring">Whm_Functions_Abstract::$_querystring</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_rest">Whm_Functions_Abstract::$_rest</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-vars">Vars</a>
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodaddzonerecord" id="addzonerecord"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">addzonerecord</span> (line <span class="line-number">55</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method will add a DNS zone record to the server.</p>
<p class="description"><p>TODO: COMPLETE CALL</p><p>Record Types: A, MX, CNAME, NS, PTR</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			addzonerecord
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$zone</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$requiredParams</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$optionalParams</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$zone</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$type</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$requiredParams</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$optionalParams</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddumpzone" id="dumpzone"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">dumpzone</span> (line <span class="line-number">123</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method displays the DNS zone configuration for a specific domain.</p>
<p class="description"><p>http://docs.cpanel.net/twiki/bin/view/SoftwareDevelopmentKit/ListOneZone</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			dumpzone
		</span>
					(<span class="var-type">$domain</span>&nbsp;<span class="var-name">$domain</span>, <span class="var-type">$line</span>&nbsp;<span class="var-name">1</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$line</span>
				<span class="var-name">1</span><span class="var-description">: string</span>			</li>
					<li>
				<span class="var-type">$domain</span>
				<span class="var-name">$domain</span><span class="var-description">: string</span>			</li>
				</ul>
		
			
	</div>
<a name="methodeditzonerecord" id="editzonerecord"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">editzonerecord</span> (line <span class="line-number">136</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			editzonerecord
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetzonerecord" id="getzonerecord"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getzonerecord</span> (line <span class="line-number">154</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method will return zone records for a domain.</p>
<p class="description"><p>To use This method most effectively, you may first wish to run the  dumpzone functionfor the domain(s) whose record(s) you wish to retrieve.  The Line output variable from that function call can then be used as a  reference to create the input for This method.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			getzonerecord
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$line</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$domain</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$line</span>			</li>
				</ul>
		
			
	</div>
<a name="methodkilldns" id="killdns"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">killdns</span> (line <span class="line-number">169</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			killdns
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodlistmxs" id="listmxs"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">listmxs</span> (line <span class="line-number">209</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			listmxs
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodlistzones" id="listzones"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">listzones</span> (line <span class="line-number">183</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method will generate a list of all domains and corresponding DNS  zones associated with your server.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			listzones
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodlookupnsip" id="lookupnsip"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">lookupnsip</span> (line <span class="line-number">188</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			lookupnsip
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$nameserver</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$nameserver</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremovezonerecord" id="removezonerecord"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">removezonerecord</span> (line <span class="line-number">194</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removezonerecord
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodresetzone" id="resetzone"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">resetzone</span> (line <span class="line-number">199</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			resetzone
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodresolvedomainname" id="resolvedomainname"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">resolvedomainname</span> (line <span class="line-number">205</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			resolvedomainname
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsavemxs" id="savemxs"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">savemxs</span> (line <span class="line-number">213</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			savemxs
		</span>
				()
			</div>
	
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html">Whm_Functions_Abstract</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#method__construct">Whm_Functions_Abstract::__construct()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodapplist">Whm_Functions_Abstract::applist()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodcheckParams">Whm_Functions_Abstract::checkParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methoddecode">Whm_Functions_Abstract::decode()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetApi">Whm_Functions_Abstract::getApi()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetMethod">Whm_Functions_Abstract::getMethod()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetParams">Whm_Functions_Abstract::getParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetQueryString">Whm_Functions_Abstract::getQueryString()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodpost">Whm_Functions_Abstract::post()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodquickpost">Whm_Functions_Abstract::quickpost()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetApi">Whm_Functions_Abstract::setApi()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetMethod">Whm_Functions_Abstract::setMethod()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetParams">Whm_Functions_Abstract::setParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetQueryString">Whm_Functions_Abstract::setQueryString()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodvalidateParams">Whm_Functions_Abstract::validateParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodversion">Whm_Functions_Abstract::version()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 06 Nov 2011 23:33:12 +1100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>